Content Understanding (preview:2024-12-01)

2025/03/17 • 9 new methods

Analyzers_List (new)
Description :  List analyzers.
Reference :  Link ¶

⚼ Request

GET:  /analyzers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of ContentAnalyzer items ,
}
{
value:
{
Description: The ContentAnalyzer items on this page ,
Required: True ,
}
[
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_Get (new)
Description :  Get analyzer properties.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_CreateOrReplace (new)
Description :  Create a new analyzer asynchronously.
Reference :  Link ¶

⚼ Request

PUT:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_Update (new)
Description :  Update analyzer properties.
Reference :  Link ¶

⚼ Request

PATCH:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_Delete (new)
Description :  Delete analyzer.
Reference :  Link ¶

⚼ Request

DELETE:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_Analyze (new)
Description :  Extract content and fields from input.
Reference :  Link ¶

⚼ Request

POST:  /analyzers/{analyzerId}:analyze
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
url:
{
Description: The URL of the document to analyze. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_GetOperationStatus (new)
Description :  Get the status of an analyzer creation operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
scenario:
{
Description: The scenario for which the analyzer is optimized. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableFace:
{
Description: Enable face detection. ,
Required: False ,
}
boolean ,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableBarcode:
{
Description: Enable barcode detection. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
}
,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
trainingData:
{
Description: The data source containing training data for the analyzer. ,
Required: False ,
}
{
kind:
{
Description: The kind of data source. ,
Enum:
{
blob: A blob storage data source. ,
}
,
Required: True ,
}
enum ,
}
,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_GetResult (new)
Description :  Get the result of an analysis operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}/results/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: Analyzer identifier. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Analyzers_GetResultImage (new)
Description :  Get an image associated with the result of an analysis operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}/results/{operationId}/images/{imageId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: Analyzer identifier. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier. ,
Required: True ,
}
string ,
imageId:
{
Description: Image identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}